/*
 * Copyright 2021 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.jmix.core;

import io.jmix.core.metamodel.model.MetaProperty;

import org.springframework.lang.Nullable;
import java.util.Locale;

/**
 * Interface to provide a caption of property, for example if the property is a dynamic attribute.
 */
public interface MessageResolver {

    /**
     * Returns localized caption of an entity property
     *
     * @param property meta property
     * @param locale   locale, if value is null locale of current user is used
     * @return localized property caption
     */
    @Nullable
    String getPropertyCaption(MetaProperty property, @Nullable Locale locale);
}
